Skip to main content

List batch import jobs for an organization.

GET 
/partner/v1.0/organizations/:organizationId/activities/batch

List batch import jobs for an organization.

Request​

Path Parameters

    organizationId stringrequired

    The ID of the organization

Query Parameters

    status ImportStatusType

    Possible values: [Accepted, Processing, Completed, CompletedWithErrors, Failed]

    Optional status filter

    limit int32

    Default value: 50

    Maximum number of jobs to return (default 50)

Responses​

OK

Schema

  • Array [

    • batchId stringnullable

    Unique identifier for the batch import.

    organizationId stringnullable

    Organization ID associated with the import.

    inventoryId stringnullable

    Inventory ID for activities (if applicable).

    sourceSystem stringnullable

    Source system identifier from the request.

    status ImportStatusType (string)

    Possible values: [Accepted, Processing, Completed, CompletedWithErrors, Failed]

    Status types for import jobs.

    totalRecords int32

    Total number of records in the import.

    processedRecords int32

    Number of records processed so far.

    createdRecords int32

    Number of records successfully created.

    updatedRecords int32

    Number of records updated.

    skippedRecords int32

    Number of records skipped (duplicates).

    failedRecords int32

    Number of records that failed to process.

    errors

    object[]

    nullable

    List of errors for failed records.

  • Array [

    • recordIndex int32

    Index of the record in the import (0-based).

    externalId stringnullable

    External ID of the record, if available.

    message stringnullable

    Error message describing the failure.

    code stringnullable

    Error code for programmatic handling.

  • ]

  • ]

Loading...